/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

package org.apache.jmeter.engine.util;

import java.util.LinkedList;

import org.apache.jmeter.testelement.TestElement;
import org.apache.jorphan.collections.HashTree;
import org.apache.jorphan.collections.HashTreeTraverser;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;

/**
 * @version $Revision: 674362 $
 */
public class DisabledComponentRemover implements HashTreeTraverser {

    /*
     * TODO - does this class work? and is it needed?
     * It is only called by Start, and then only after
     * having called convertTree - which removes the disabled elements anyway.
     * When tried in IncludeController, it failed to work.
    */

    private static final Logger log = LoggingManager.getLoggerForClass();

    HashTree tree;

    LinkedList stack = new LinkedList();

    public DisabledComponentRemover(HashTree tree) {
        this.tree = tree;
    }

    public void addNode(Object node, HashTree subTree) {
        stack.addLast(node);
    }

    public void subtractNode() {
        Object removeLast = stack.removeLast();
        if (!(removeLast instanceof TestElement)) {
            log.warn("Expected class TestElement, found "+removeLast.getClass().getName());
            return;
        }
        TestElement lastNode = (TestElement) removeLast;
        if (!lastNode.getPropertyAsBoolean(TestElement.ENABLED)) {
            log.info("*** Removing *** "+lastNode);// TODO not sure this is ever called
            tree.getTree(stack).remove(lastNode);
        }
    }

    public void processPath() {
    }
}
